Node / ReticulumProjects / MeshChatX.git / files / vendor / lxmfy / lxmfy / help.py

Displaying Raw • Download

T8b949e"""Help command system for LXMFy."""

Tff7b72from T7ee787dataclasses Tff7b72import Te6edf3dataclass

Tff7b72from T7ee787.T7ee787permissions Tff7b72import Te6edf3DefaultPerms

Tf0883e@dataclass

Tff7b72class T56d364HelpFormatterTb4b4b4:

T8b949e"""Default help formatter for commands."""

Tf0883e@staticmethod

Tff7b72def Td2a8ffformat_commandTb4b4b4(Te6edf3commandTb4b4b4) Tff7b72-Tff7b72> Tffa657strTb4b4b4:

T8b949e"""Format a single command's help.

Args:

command: The command object to format.

Returns:

A formatted string containing the command's help information.

"""

Te6edf3help_text Tff7b72= Tb4b4b4[

Ta5d6fffTa5d6ff"Ta5d6ff**Command**: `Tffd700{Te6edf3commandTff7b72.Td2a8ffnameTffd700}Ta5d6ff`Ta5d6ff"Tb4b4b4,

Ta5d6fffTa5d6ff"Ta5d6ff**Description**: Tffd700{Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffdescriptionTffd700}Ta5d6ff"Tb4b4b4,

Tb4b4b4]

Tff7b72if Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffaliasesTb4b4b4:

Te6edf3help_textTff7b72.Td2a8ffappendTb4b4b4(

Ta5d6fffTa5d6ff"Ta5d6ff**Aliases**: Tffd700{Ta5d6ff'Ta5d6ff, Ta5d6ff'Tff7b72.Td2a8ffjoinTb4b4b4(Ta5d6fffTa5d6ff'Ta5d6ff`Tffd700{Te6edf3aTffd700}Ta5d6ff`Ta5d6ff' Tff7b72for Te6edf3a Tff7b72in Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffaliasesTb4b4b4)Tffd700}Ta5d6ff"Tb4b4b4,

Tb4b4b4)

Tff7b72if Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffusageTb4b4b4:

Te6edf3help_textTff7b72.Td2a8ffappendTb4b4b4(Ta5d6fffTa5d6ff"Ta5d6ff**Usage**: `Tffd700{Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffusageTffd700}Ta5d6ff`Ta5d6ff"Tb4b4b4)

Tff7b72if Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffexamplesTb4b4b4:

Te6edf3help_textTff7b72.Td2a8ffappendTb4b4b4(Ta5d6ff"Ta5d6ff**Examples**:Ta5d6ff"Tb4b4b4)

Te6edf3help_textTff7b72.Td2a8ffextendTb4b4b4(Ta5d6fffTa5d6ff"Ta5d6ff - `Tffd700{Te6edf3exTffd700}Ta5d6ff`Ta5d6ff" Tff7b72for Te6edf3ex Tff7b72in Te6edf3commandTff7b72.Td2a8ffhelpTff7b72.Td2a8ffexamplesTb4b4b4)

Tff7b72if Te6edf3commandTff7b72.Td2a8ffpermissions Tff7b72!= Te6edf3DefaultPermsTff7b72.Td2a8ffUSE_COMMANDSTb4b4b4:

Te6edf3perms Tff7b72= Tb4b4b4[

Te6edf3permTff7b72.Td2a8ffname

Tff7b72for Te6edf3perm Tff7b72in Te6edf3DefaultPerms

Tff7b72if Tb4b4b4(Te6edf3permTff7b72.Td2a8ffvalue Tff7b72& Te6edf3commandTff7b72.Td2a8ffpermissionsTff7b72.Td2a8ffvalueTb4b4b4)

Tff7b72and Te6edf3perm Tff7b72!= Te6edf3DefaultPermsTff7b72.Td2a8ffNONE

Tb4b4b4]

Tff7b72if Te6edf3permsTb4b4b4:

Te6edf3help_textTff7b72.Td2a8ffappendTb4b4b4(Ta5d6ff"Ta5d6ff**Required Permissions**:Ta5d6ff"Tb4b4b4)

Te6edf3help_textTff7b72.Td2a8ffextendTb4b4b4(Ta5d6fffTa5d6ff"Ta5d6ff - Tffd700{Te6edf3pTffd700}Ta5d6ff" Tff7b72for Te6edf3p Tff7b72in Te6edf3permsTb4b4b4)

Tff7b72if Te6edf3commandTff7b72.Td2a8ffadmin_onlyTb4b4b4:

Te6edf3help_textTff7b72.Td2a8ffappendTb4b4b4(Ta5d6ff"Ta5d6ff*(Admin only)*Ta5d6ff"Tb4b4b4)

Tff7b72return Ta5d6ff"Tffea00\nTa5d6ff"Tff7b72.Td2a8ffjoinTb4b4b4(Te6edf3help_textTb4b4b4)

Tf0883e@staticmethod

Tff7b72def Td2a8ffformat_categoryTb4b4b4(Te6edf3categoryTb4b4b4: Tffa657strTb4b4b4, Te6edf3commandsTb4b4b4: Tffa657listTb4b4b4) Tff7b72-Tff7b72> Tffa657strTb4b4b4:

T8b949e"""Format a category of commands.

Args:

category (str): The name of the category.

commands (list): A list of command objects in the category.

Returns:

str: A formatted string containing the category's help information.

"""

T8b949e# Deduplicate commands (aliases point to same command)

Te6edf3unique_cmds Tff7b72= Tb4b4b4{Tb4b4b4}

Tff7b72for Te6edf3cmd Tff7b72in Te6edf3commandsTb4b4b4:

Te6edf3unique_cmdsTb4b4b4[Te6edf3cmdTff7b72.Td2a8ffnameTb4b4b4] Tff7b72= Te6edf3cmd

Te6edf3help_text Tff7b72= Tb4b4b4[Ta5d6fffTa5d6ff"Tffea00\nTa5d6ff**Tffd700{Te6edf3categoryTffd700}Ta5d6ff**Ta5d6ff"Tb4b4b4]

Te6edf3help_textTff7b72.Td2a8ffextendTb4b4b4(

Ta5d6fffTa5d6ff"Ta5d6ff * `Tffd700{Te6edf3cmdTff7b72.Td2a8ffnameTffd700}Ta5d6ff`: Tffd700{Te6edf3cmdTff7b72.Td2a8ffhelpTff7b72.Td2a8ffdescriptionTffd700}Ta5d6ff"

Tff7b72for Te6edf3cmd Tff7b72in Tffa657sortedTb4b4b4(Te6edf3unique_cmdsTff7b72.Td2a8ffvaluesTb4b4b4(Tb4b4b4)Tb4b4b4, Te6edf3keyTff7b72=Tff7b72lambda Te6edf3xTb4b4b4: Te6edf3xTff7b72.Td2a8ffnameTb4b4b4)

Tb4b4b4)

Tff7b72return Ta5d6ff"Tffea00\nTa5d6ff"Tff7b72.Td2a8ffjoinTb4b4b4(Te6edf3help_textTb4b4b4)

Tf0883e@staticmethod

Tff7b72def Td2a8ffformat_all_commandsTb4b4b4(Te6edf3categoriesTb4b4b4: Tffa657dictTb4b4b4[Tffa657strTb4b4b4, Tffa657listTb4b4b4]Tb4b4b4) Tff7b72-Tff7b72> Tffa657strTb4b4b4:

T8b949e"""Format the complete help listing.

Args:

categories (dict): A dictionary where keys are category names and values are lists of command objects.

Returns:

str: A formatted string containing help information for all commands.

"""

Te6edf3help_text Tff7b72= Tb4b4b4[Ta5d6ff"Ta5d6ff**Bot Help Menu**Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffUse `help <command>` for more details.Ta5d6ff"Tb4b4b4]

Te6edf3help_textTff7b72.Td2a8ffextendTb4b4b4(

Te6edf3HelpFormatterTff7b72.Td2a8ffformat_categoryTb4b4b4(Te6edf3categoryTb4b4b4, Te6edf3categoriesTb4b4b4[Te6edf3categoryTb4b4b4]Tb4b4b4)

Tff7b72for Te6edf3category Tff7b72in Tffa657sortedTb4b4b4(Te6edf3categoriesTff7b72.Td2a8ffkeysTb4b4b4(Tb4b4b4)Tb4b4b4)

Tb4b4b4)

Tff7b72return Ta5d6ff"Tffea00\nTa5d6ff"Tff7b72.Td2a8ffjoinTb4b4b4(Te6edf3help_textTb4b4b4)

Tff7b72class T56d364HelpSystemTb4b4b4:

T8b949e"""A system for providing help information about available commands."""

Tff7b72def Tff7b72__init__Tb4b4b4(Tff7b72selfTb4b4b4, Te6edf3botTb4b4b4, Te6edf3formatterTff7b72=Tff7b72NoneTb4b4b4)Tb4b4b4:

T8b949e"""Initialize the HelpSystem.

Args:

bot: The bot instance.

formatter: An optional help formatter. Defaults to HelpFormatter.

"""

Tff7b72selfTff7b72.Td2a8ffbot Tff7b72= Te6edf3bot

Tff7b72selfTff7b72.Td2a8ffformatter Tff7b72= Te6edf3formatter Tff7b72or Te6edf3HelpFormatterTb4b4b4(Tb4b4b4)

Tf0883e@botTff7b72.Td2a8ffcommandTb4b4b4(Te6edf3nameTff7b72=Ta5d6ff"Ta5d6ffhelpTa5d6ff"Tb4b4b4, Te6edf3descriptionTff7b72=Ta5d6ff"Ta5d6ffShow help for commandsTa5d6ff"Tb4b4b4)

Tff7b72def Td2a8ffhelp_commandTb4b4b4(Te6edf3ctxTb4b4b4)Tb4b4b4:

T8b949e"""Handle the 'help' command.

Args:

ctx: The command context.

"""

Te6edf3args Tff7b72= Te6edf3ctxTff7b72.Td2a8ffargs

Tff7b72if Tff7b72not Te6edf3argsTb4b4b4:

Te6edf3categories Tff7b72= Tff7b72selfTff7b72.Td2a8ff_get_categorized_commandsTb4b4b4(Te6edf3ctxTff7b72.Td2a8ffis_adminTb4b4b4)

Te6edf3response Tff7b72= Tff7b72selfTff7b72.Td2a8ffformatterTff7b72.Td2a8ffformat_all_commandsTb4b4b4(Te6edf3categoriesTb4b4b4)

Te6edf3ctxTff7b72.Td2a8ffreplyTb4b4b4(Te6edf3responseTb4b4b4)

Tff7b72return

Te6edf3command_name Tff7b72= Te6edf3argsTb4b4b4[T79c0ff0Tb4b4b4]

Tff7b72if Te6edf3command_name Tff7b72in Tff7b72selfTff7b72.Td2a8ffbotTff7b72.Td2a8ffcommandsTb4b4b4:

Te6edf3command Tff7b72= Tff7b72selfTff7b72.Td2a8ffbotTff7b72.Td2a8ffcommandsTb4b4b4[Te6edf3command_nameTb4b4b4]

Tff7b72if Te6edf3commandTff7b72.Td2a8ffadmin_only Tff7b72and Tff7b72not Te6edf3ctxTff7b72.Td2a8ffis_adminTb4b4b4:

Te6edf3ctxTff7b72.Td2a8ffreplyTb4b4b4(Ta5d6ff"Ta5d6ffThis command is for administrators only.Ta5d6ff"Tb4b4b4)

Tff7b72return

Te6edf3response Tff7b72= Tff7b72selfTff7b72.Td2a8ffformatterTff7b72.Td2a8ffformat_commandTb4b4b4(Te6edf3commandTb4b4b4)

Te6edf3ctxTff7b72.Td2a8ffreplyTb4b4b4(Te6edf3responseTb4b4b4)

Tff7b72return

Te6edf3ctxTff7b72.Td2a8ffreplyTb4b4b4(Ta5d6fffTa5d6ff"Ta5d6ffCommand Ta5d6ff'Tffd700{Te6edf3command_nameTffd700}Ta5d6ff'Ta5d6ff not found.Ta5d6ff"Tb4b4b4)

Tff7b72return

Tff7b72def Td2a8ff_get_categorized_commandsTb4b4b4(Tff7b72selfTb4b4b4, Te6edf3is_adminTb4b4b4: Tffa657boolTb4b4b4) Tff7b72-Tff7b72> Tffa657dictTb4b4b4[Tffa657strTb4b4b4, Tffa657listTb4b4b4]Tb4b4b4:

T8b949e"""Group commands by category.

Args:

is_admin (bool): Whether the user is an admin.

Returns:

dict[str, list]: A dictionary where keys are category names and values are lists of command objects.

"""

Te6edf3categories Tff7b72= Tb4b4b4{Tb4b4b4}

Tff7b72for Te6edf3cmd Tff7b72in Tff7b72selfTff7b72.Td2a8ffbotTff7b72.Td2a8ffcommandsTff7b72.Td2a8ffvaluesTb4b4b4(Tb4b4b4)Tb4b4b4:

Tff7b72if Te6edf3cmdTff7b72.Td2a8ffadmin_only Tff7b72and Tff7b72not Te6edf3is_adminTb4b4b4:

Tff7b72continue

Te6edf3category Tff7b72= Te6edf3cmdTff7b72.Td2a8ffhelpTff7b72.Td2a8ffcategory Tff7b72or Ta5d6ff"Ta5d6ffGeneralTa5d6ff"

Tff7b72if Te6edf3category Tff7b72not Tff7b72in Te6edf3categoriesTb4b4b4:

Te6edf3categoriesTb4b4b4[Te6edf3categoryTb4b4b4] Tff7b72= Tb4b4b4[Tb4b4b4]

Te6edf3categoriesTb4b4b4[Te6edf3categoryTb4b4b4]Tff7b72.Td2a8ffappendTb4b4b4(Te6edf3cmdTb4b4b4)

Tff7b72return Te6edf3categories